home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 025a / stampman.zip / STAMP_V2.DOC < prev    next >
Text File  |  1989-04-27  |  20KB  |  483 lines
  1.  
  2.  
  3.  
  4.             STAMPMAN -- The Stamp Collector's Manager
  5.  
  6.                            Version 2.0 
  7.  
  8.                            April, 1989
  9.  
  10.  
  11.  
  12.  
  13. StampMan was created for the philatelist who wants to organize 
  14. his collection but doesn't have the time to enter all the catalog 
  15. information himself or use a commercial program with more 
  16. features than he may need. The program and the catalog files are 
  17. intended to be "User Supported" software that is useful to all. 
  18. StampMan uses indexed B-Tree files to help the collector organize 
  19. his collection using both a Main and an Alternate Catalog 
  20. listing.  System requirements are an IBM PC or compatible with a 
  21. minimum of 256K and a disk drive. The program is menu driven with 
  22. 1-2-3 like sub menu options and prompted input to simplify data 
  23. entry and minimize user errors.  
  24.  
  25. 
  26. STARTING STAMPMAN
  27.  
  28. The program is started by entering "STAMPMAN" at the DOS prompt 
  29. along with optional command line parameters.  
  30.  
  31.      A> stampman [drive:\directory\datafile]
  32.  
  33. Optional command line parameters are used to specify the drive, 
  34. directory path and data file names desired for use. If no 
  35. parameters are specified the following defaults are used: 
  36.  
  37.                 Drive           : default drive 
  38.                                   when program was started
  39.                 Directory       : current directory
  40.                 Data File       : "StampFil.DAT"
  41.  
  42. Entering a drive parameter such as "B:" makes the program look 
  43. for the data and index files on the specified drive. Similarly 
  44. entering a directory parameter such as "\stampman\" makes the 
  45. program look in the directory \stamps for the required data and 
  46. index files. A data file name may be entered but it must be 
  47. entered without an extension.  If a data file name is entered, 
  48. StampMan looks for files with the name of the parameter string 
  49. and the following extensions: 
  50.  
  51.           DataFile        : <Parameter String> + ".dat"
  52.           Main Index      : <Parameter String> + ".in1"
  53.           Alternate Index : <Parameter String> + ".in2"
  54.  
  55. StampMan will ignore any extension entered on the command line.  
  56.  
  57. Any or all the optional parameters may be specified on the 
  58. command line.  
  59.  
  60. For Example -
  61.  
  62.       stampman \stamps\       would use      default drive
  63.                                   "\stamps"      directory
  64.                                   " StampFil.DAT" datafile
  65.  
  66.       stampman B:canada       would   use         drive B:
  67.                                  current path for drive B:
  68.                                     "Canada.DAT"  datafile
  69.  
  70. Note that any directory specification must be preceded by and 
  71. followed with a backslash. Otherwise, StampMan considers it a 
  72. Data File specification.  
  73.  
  74. Note also that specifying a drive and/or directory also
  75. changes the DOS defaults for the drive and directory path.  
  76.  
  77. If the data files and index files are present, StampMan opens 
  78. them for processing and displays the Main Menu.  If the files are 
  79. not present, StampMan asks if they should be created. Entering 
  80. 'Y' will create and open the required data and index files for 
  81. processing. Entering 'N' will not create the files but will 
  82. display the Main Menu. The default drive, directory and/or file 
  83. name specification may then be changed using the "Utilities" 
  84. option from the Main Menu.  
  85.  
  86. StampMan runs in color by sensing the video mode in effect when 
  87. the program is started. If a monochrome mode is detected, the 
  88. program will run in monochrome. If a color mode is detected, the 
  89. program will run in color.  You can force color or mono by 
  90. running the auxiliary programs "COLOR.EXE" or "MONO.EXE" 
  91. respectively from the command line prior to starting StampMan. 
  92.  
  93. 
  94. STAMPMAN MAIN MENU 
  95. -------- ---- ----
  96. The main body of the program is controlled from the Main Menu. 
  97. The Main Menu lists the following options:
  98.  
  99.          1 - VIEW LISTING
  100.          2 - ADD TO INVENTORY
  101.          3 - MODIFY CATALOG LISTINGS
  102.          4 - DELETE FROM INVENTORY
  103.          5 - REPORTS
  104.          6 - UTILITY
  105.          7 - SWITCH CATALOG
  106.          8 - DATABASE STATISTICS
  107.          9 - EXIT
  108.  
  109. Selection may be made by either entering the respective number 
  110. (1-9) or by moving the highlighted box with the up or down arrows 
  111. and pressing <Enter>.
  112.  
  113. The following describes each of the options of the Main Menu.
  114.  
  115.  
  116. 1 - VIEW LISTING
  117. -   ---- -------
  118.  
  119. This selection is used to view a single stamp Catalog Listing.  
  120. Enter the following inforamation at the prompts:
  121.  
  122.         Prompt                 Example Entries
  123.  
  124.         Catalog Type           A, B, C, CE, J, Q, etc.
  125.         Catalog Number         1 - 9999
  126.         Catalog Variety        a, b, c, *, or <Null>
  127.  
  128. Pressing the Enter key at the Catalog Type prompt defaults to 
  129. type " " (Blank) which is regular issues for all catalogs. If the 
  130. Catalog Listing desired does not include a Variety type, simply 
  131. press <Enter> at the prompt. 
  132.  
  133. If the Listing entered for display cannot be found in the active 
  134. index file, a message is displayed. Pressing <Enter> 
  135. returns to the Main Menu.  
  136.  
  137. If the Listing is found in the active index file, the requested 
  138. Catalog Listing is displayed.  Pressing PageUp will display the 
  139. previous stamp Catalog Listing as defined by the active index 
  140. file and pressing PageDn will display the next stamp Catalog 
  141. Listing similarly. Pressing <Enter> returns to the Main Menu. 
  142. StampMan will also return to the Main Menu if PageUp or PageDn 
  143. reaches the beginning or the end of the active index file.  
  144.  
  145. 
  146. 2 - ADD NEW LISTING
  147. -   --- --- -------
  148.  
  149. This selection is used to add a new Listing to the Catalog. Do 
  150. not use this Main Menu selection to modify an existing Stamp 
  151. Catalog Listing. If this Main Menu selection is made immediately 
  152. after starting the program, a blank screen is displayed with 
  153. prompted input to the highlighted fields. If previous Main Menu 
  154. selections have accessed Catalog listings. The last Stamp Catalog 
  155. Listing accessed is used as a default buffer for editing of the 
  156. fields for the New Listing.  
  157.  
  158.         Press <Enter> to accept the buffer 
  159.         Press Right Arrow to accept a character from the Buffer
  160.         Enter a character to replace an Entry character
  161.         Press Backspace to delete the character to the left
  162.  
  163.  
  164.                             IMPORTANT:
  165.  
  166. StampMan accepts from the first character to the character to the 
  167. immediate left of the cursor as the Entry.
  168.  
  169. After the last field of the New Listing has been entered, 
  170. StampMan prompts to accept or modify the newly entered data for 
  171. the New Listing. Pressing <M> (for Modify) repeats the data input 
  172. using the newly entered data as a default buffer. Pressing 
  173. <Enter> accepts the newly entered data for the New Listing.  
  174.  
  175. If another New Listing is to be entered, pressing PgDn repeats 
  176. the New Listing entry procedure as listed above with the previous 
  177. New Listing data used as the default buffer.
  178.  
  179. Pressing <Enter> returns to the Main Menu.
  180.  
  181. 
  182. 3 - MODIFY CATALOG LISTINGS
  183. -   ------ ------- --------
  184.  
  185. This selection is used to modify data entries for existing Stamp 
  186. Catalog listings. Do not use this Main Menu selection to add a 
  187. New Stamp Catalog listing. StampMan prompts for the Catalog Type, 
  188. Catalog Number, and Catalog Variety as described for Main Menu 
  189. selection "1 - View". If the Stamp Catalog Listing is found in 
  190. the active index file the program prompts for the extent of the 
  191. modifications. The options available are: 
  192.  
  193.     Option                      Description
  194.  
  195.     Modify Listings             Edit All Items
  196.     Modify Values               Edit Catalog Values Only
  197.     Modify Inventory            Edit Inventory Numbers Only
  198.     Quit                        Do not Edit - Return to Main Menu 
  199.  
  200. Selection of a Modify option is made by either pressing the first 
  201. letter of the option (i.e. <L> for Listings) or by using the left 
  202. and right arrow keys to highlight the desired selection and 
  203. pressing <Enter>.  
  204.  
  205. Editing of data is simlar to entering new data with the existing 
  206. data used as the default buffer.
  207.  
  208. After the last field has been entered, StampMan prompts to either 
  209. accept or re-edit the data. Once the Modified Listing is 
  210. accepted, pressing PageDn allows editing of the previous Catalog 
  211. Listing and pressing PageUp allows editing of the next Catalog 
  212. Listing as defined by the active index file. Pressing <Enter> 
  213. returns to the Main Menu.  
  214.     
  215.  
  216. 4 - DELETE FROM INVENTORY
  217. -   ------ ---- ---------
  218.  
  219. This Main Menu Selection is used to delete a stamp Catalog 
  220. Listing from the data file and index files. Do not use this 
  221. selection to modify inventory. StampMan prompts for the Catalog 
  222. Type, Catalog Number, and Catalog Variety of the Catalog Listing 
  223. to be deleted from the Catalog file.  
  224.  
  225. If the Catalog Listing entered is not found in the active index 
  226. file, a message is displayed. Pressing <Enter> will return to the 
  227. Main Menu.  
  228.  
  229. If the Catalog Listing entered is found in the active index file, 
  230. the Listing is displayed. Pressing <D> at the prompt will delete 
  231. the Catalog Listing while pressing <Enter> will abort the delete 
  232. procedure and return to the Main Menu.  
  233.  
  234. Pressing <Enter> after the deletion will return to the Main Menu.  
  235.  
  236. 
  237. 5 - DISPLAY OR PRINT A REPORT
  238. -   ------- -- ----- - ------
  239.  
  240. This selection is used to produce reports from the Catalog data 
  241. file. StampMan first prompts for the destination of the report. 
  242. Available options are:
  243.  
  244.        Option                     Description
  245.  
  246.        Screen                     The DOS con: device(screen)
  247.        Printer                    The DOS prn: device(printer)
  248.        File                       A disk file
  249.        Quit                       Return to Main Menu
  250.  
  251. If the File option is chosen, StampMan prompts for the file name. 
  252. All DOS drive and/or directory specifications are supported.
  253.  
  254. StampMan then prompts for the Report type. Available Report Types 
  255. are as follows:
  256.  
  257.            Catalog Report
  258.            General Report
  259.            Inventory Report
  260.            Cross Reference
  261.  
  262. Catalog and General Reports report only Catalog information 
  263. without inventories. The Inventory report lists and totals stamp 
  264. Catalog Listings and Catalog Totals as requested at the next 
  265. prompt.  Cross Reference reports both Main and Alternate Catalog 
  266. numbers sorted on the active index file.  
  267.  
  268. Note that General reports exceed 80 columns. They therefore are 
  269. displayed on two lines when sent to the screen. If they are sent 
  270. to a dot matrix printer, it is suggested a printer setup utility 
  271. be used to set the printer to compressed mode. The DOS 'MODE' 
  272. command may also be used.  
  273.     
  274. StampMan will next prompt for the Range of the report. Available 
  275. Report Ranges are as follows:
  276.  
  277.        Catalog    Entire Catalog file is reported
  278.        Partial    Partial Catalog is reported
  279.        Mint       Only Mint listings inventoried are reported
  280.        Used       Only Used listings inventoried are reported
  281.        PB/LP      Only PB/LP listings inventoried are reported
  282.        FDC        Only FDC listings inventoried are reported
  283.  
  284. If Partial catalog is selected, StampMan requests the starting 
  285. and ending Stamp Catalog listing for the report using the active 
  286. index file.  
  287.  
  288. Selecting one of the inventory options will report only non zero 
  289. inventory listings as requested.  
  290.  
  291. Future versions of StampMan may include Want List Reports and 
  292. more customized Reports if user support is requested.
  293.  
  294. 
  295. 6 - UTILITIES
  296. -   ---------
  297.                                                    
  298. This selection is used for the following options while running 
  299. StampMan:
  300.  
  301.     Import Data
  302.     Export Data
  303.     Rebuild Index Files
  304.     Change Default Drive
  305.     Change Default Directory
  306.     Change Data File Name
  307.     File Directory
  308.  
  309. Import and Export are used to transfer Catalog listings in and 
  310. out of the Database. Files can be exported and imported either
  311. as StampMan typed files, according to the file structure listed 
  312. in Appendix A, or as pure ASCII system data format (SDF) files,
  313. which can be read by other programs such as dBase and its' clones.
  314. A sample dBase III+ file with the correct structure to match
  315. StampMan's SDF files is provided with the program.
  316.  
  317. Rebuild Index Files will rebuild both Alternate and Main index 
  318. files using all active stamp Catalog Listings. Use this option if 
  319. the program cannot seem to find Catalog Listings that are known 
  320. to be present in the Stamp Catalog Data File. A corrupted index 
  321. file can be fatal to a database. Note that importing a data file 
  322. causes an automatic Rebuild of all index files. 
  323.  
  324. Changing Default Drive, Default Directory, or File Name causes 
  325. StampMan to close existing open files and switch to the specified 
  326. path and/or names to search for data and index files to open. 
  327. Note that changing the specified drive and/or active directory 
  328. here changes the DOS default drive and path.
  329.  
  330. File Directory gives a listing of all files and their size from 
  331. the specified Drive, Directory, and file mask. The default file 
  332. mask is "*.*" for the current default drive and directory. 
  333.  
  334. 7 - SWITCH CATALOG
  335. -   ------ -------
  336.  
  337. This Main Menu selection will toggle StampMan between using the 
  338. Main and Alternate Catalog Numbers and index files as the active 
  339. Catalog and index file.
  340.  
  341. If the Alternate Catalog is selected to be active,
  342.  
  343.                        "ALTERNATE CATALOG "
  344.  
  345. will be displayed on all screens. The alternate catalog option is 
  346. provided to allow the user to use Scott, Stanley Gibbons, Michel, 
  347. Minkus, or other catalogs to work with different dealers.
  348.  
  349. 8 - DATABASE STATISTICS
  350. -   -------- ----------
  351.  
  352. This selection displays the default drive, directory and filename and
  353. the number of Active Catalog Listings and total file size for the 
  354. active Data File.
  355.  
  356. 9 - EXIT
  357. This selection will close all open files, clear the screen, and 
  358. return to the DOS with the to current drive and directory.
  359.  
  360.  
  361. APPENDIX A
  362.  
  363. STRUCTURE OF THE STAMP RECORDS
  364.  
  365. The database files use the following data structure as created by Turbo Pascal:
  366.  
  367.   StampRec = record
  368.     Status               : integer;          (* 0-Non Deleted*) 
  369.     Catalog Type         : string[2];        { Character: Length  2}
  370.     Catalog Number       : string[10];       { Character: Length 10}
  371.     Catalog Variety      : string[1];        { Character: Length  1} 
  372.     Alternate Type       : string[2];        { Character: Length  2} 
  373.     Alternate Number     : string[10];       { Character: Length 10} 
  374.     Alternate Variety    : string[1];        { Character: Length  1} 
  375.     Issue Date           : string[10];       { Character: Length 10} 
  376.     Denomination         : string[10];       { Character: Length 10} 
  377.     Description          : string[30];       { Character: Length 30} 
  378.     Perforation          : string[10];       { Character: Length 10} 
  379.     Series               : string[20];       { Character: Length 20} 
  380.     Quantity Issued      : real;             { Numeric  : Length 10: Dec 0}
  381.     Number in PB/LP      : integer;          { Numeric  : Length  3: Dec 0}
  382.     Unused Value         : real;             { Numeric  : Length  8: Dec 2}
  383.     Used   Value         : real;             { Numeric  : Length  8: Dec 2}
  384.     PB/LP  Value         : real;             { Numeric  : Length  8: Dec 2}
  385.     FDC    Value         : real;             { Numeric  : Length  8: Dec 2}
  386.     Unused Inventory     : integer;          { Numeric  : Length  3: Dec 0}
  387.     Used   Inventory     : integer;          { Numeric  : Length  3: Dec 0}
  388.     PB/LP  Inventory     : integer;          { Numeric  : Length  3: Dec 0}
  389.     FDC    Inventory     : integer;          { Numeric  : Length  3: Dec 0} 
  390.   end; (* StampRec *)                        { SDF File Format }
  391.  
  392. Note that StampMan will function more efficiently if the number of 
  393. buffers present is increased above the default of 2 used by DOS. 
  394. The exact number to be used in the 'CONFIG.SYS' file is dependent 
  395. upon the amount of system memory present but even a small memory 
  396. machine can use eight to ten buffers. Increasing buffers increases 
  397. the possibility that a record is in memory and therefore decreases 
  398. the number of disk accesses and increases program speed.  
  399.  
  400. Disk caches are another method of speeding file access. StampMan has 
  401. been tested on many caching programs and has proven compatible and 
  402. reliable with them. As a matter of fact, for pure speed, they can only 
  403. be beat by a full RAM disk.
  404.  
  405. The use of a RAM disk increases program speed and saves wear and tear 
  406. on disk drives. A RAM disk driver is provided on the DOS 3.00 and later 
  407. disks. Other RAM disk drivers are available in the Public Domain.
  408.  
  409. Please contact the author if there are any problems and/or questions 
  410. regarding use of this program and system configurations.  
  411.  
  412. 
  413. APPENDIX B
  414.  
  415. ASSOCIATED FILES
  416.  
  417. The following files constitute the StampMan system as 
  418. distributed:
  419.  
  420.         StampMan.exe            Program executable file
  421.  
  422.         Stamp_V2.Doc            Program Documnetation
  423.        
  424.         ReadMe.Now              Conversion Information File
  425.  
  426.         Convert.exe             program file to convert Version 1.0
  427.                                 data and index files for Version 2.0
  428.  
  429.         Convert.doc             documentation for Convert
  430.  
  431.         StampFil.dat            sample database file with
  432.                                 US Parcel Post stamps and
  433.                                 US Air Mail stamps
  434.  
  435.         StampFil.In1            Index file for above
  436.  
  437.         StampFil.In2            Index file for above
  438.  
  439.         StampFil.dbf            dBase III+ file structured for 
  440.         StampFil.sdf            SDF file export/import
  441.  
  442.  
  443. SUPPORT AND INFORMATION
  444.  
  445. StampMan has been developed as User Supported software. The 
  446. program and related files may be distributed freely but must 
  447. include all files listed under Appendix B. Please feel free to 
  448. write to the author for further information.
  449.  
  450. Additional support is available for data transfer to dBaseII, 
  451. dBaseIII, Lotus programs, and other database program file 
  452. formats. In addition, Catalog files will be available for both 
  453. United States and Canada stamps using Scott, Minkus, and the 
  454. Canadian Numbering System (Lyman's). Additional catalogs may be 
  455. developed if demands justify them. I cannot tell if the demand is 
  456. there if the users don't tell me.
  457.  
  458. Requests for information and additional support should be 
  459. directed to:
  460.  
  461.                 Ernie Yonkers
  462.                 1712 Roseland
  463.                 Royal Oak, Michigan 48073
  464.  
  465. If you find the program useful, a donation of $10.00 payable to 
  466. the author will register you. Registered users may also request 
  467. the source files for the program if a Self Stamped Addressed Disk 
  468. and Mailer is sent to the author. Please note that Borland 
  469. support (Turbo Toolbox) software is copyrighted and as such is 
  470. not included in source code.
  471.  
  472. Questions and suggestions for improvements are always welcome for 
  473. registered users. Please remember, however, that he author is a full 
  474. time engineer and family man with four beautiful children that like 
  475. to eat.  Responses will be quicker if accompanied by proper registration 
  476. fees. I certainly don't mean to sound crass, but Shareware is not intended 
  477. to be free.  I will stop short of vexing you with an ancient Bohemian curse 
  478. regarding your love life.
  479.  
  480. Your cooperation in making the User Supported Software concept 
  481. work will be appreciated by all Computer users. Thank You.  
  482.  
  483.